/*
 * Copyright 2007-2008 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package jsr203.nio.file;

/**
 * A task that performs match operations on file names.
 *
 * @since 1.7
 *
 * @see FileSystem#getNameMatcher
 * @see Path#newDirectoryStream(String)
 */

public interface NameMatcher {
    /**
     * Matches the given file name against this matcher's pattern.
     *
     * @param   name
     *          The file name to match
     *
     * @return  {@code true} if, and only if, the file name matches this
     *          matcher's pattern
     *
     * @throws  IllegalArgumentException
     *          If the {@code name} has a root component or more than one
     *          name component
     */
    boolean match(Path name);
}
